Skip to content

Add an auto-generated unicode character category file#4605

Open
TheBlueMatt wants to merge 1 commit intolightningdevkit:mainfrom
TheBlueMatt:2026-05-unicode-autogen
Open

Add an auto-generated unicode character category file#4605
TheBlueMatt wants to merge 1 commit intolightningdevkit:mainfrom
TheBlueMatt:2026-05-unicode-autogen

Conversation

@TheBlueMatt
Copy link
Copy Markdown
Collaborator

1a01b5a added detection of unicode format characters in PrintableString, but used a hard-coded table which may eventually become out of date.

Here we switch to an auto-generated table, include all General_Category Other characters, and also ban unallocated code points.

Finally, CI validates that the file is kept up to date.

Written by Claude

@ldk-reviews-bot
Copy link
Copy Markdown

ldk-reviews-bot commented May 7, 2026

👋 Thanks for assigning @tnull as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

@TheBlueMatt TheBlueMatt requested a review from tnull May 7, 2026 18:47
@TheBlueMatt TheBlueMatt force-pushed the 2026-05-unicode-autogen branch from b6f8c03 to bd75483 Compare May 7, 2026 18:49
Comment on lines +36 to +38
let is_other = is_unicode_general_category_other(c);
let is_unassigned = is_unicode_general_category_unassigned(c);
let c = if c.is_control() || is_other || is_unassigned {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: c.is_control() is now fully redundant — it checks Cc (Control), which is already covered by is_unicode_general_category_other (see 0x0000..=0x001F and 0x007F..=0x009F in unicode.rs). The old code needed it because is_format_char only covered Cf, but the new function covers all of Cc / Cf / Cs / Co.

Not a bug (the || short-circuits harmlessly), but it's potentially confusing because it suggests is_other doesn't handle control characters.

Suggested change
let is_other = is_unicode_general_category_other(c);
let is_unassigned = is_unicode_general_category_unassigned(c);
let c = if c.is_control() || is_other || is_unassigned {
let c = if is_unicode_general_category_other(c) || is_unicode_general_category_unassigned(c) {

@ldk-claude-review-bot
Copy link
Copy Markdown
Collaborator

ldk-claude-review-bot commented May 7, 2026

Review Summary

New issue found

  • .github/workflows/check_unicode.yml:25gh issue create runs without deduplication; will create a new issue every day the file is out of date. build.yml already demonstrates the correct pattern (check for existing open issue, comment on it instead).

Correction to prior review

My three prior comments about the YAML workflow file (missing jobs: key, missing checkout step, fi indentation) were incorrect — the file structure is fine as written. I misread the diff indentation. Apologies for the noise.

Prior comment still applicable

  • lightning-types/src/string.rs:38c.is_control() remains redundant with is_unicode_general_category_other, which already covers all Cc characters.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

❌ Patch coverage is 92.23301% with 40 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.15%. Comparing base (1a01b5a) to head (65e8cc8).
⚠️ Report is 66 commits behind head on main.

Files with missing lines Patch % Lines
lightning-types/src/unicode.rs 92.18% 40 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4605      +/-   ##
==========================================
+ Coverage   86.09%   86.15%   +0.06%     
==========================================
  Files         157      158       +1     
  Lines      108828   109323     +495     
  Branches   108828   109323     +495     
==========================================
+ Hits        93694    94189     +495     
+ Misses      12519    12518       -1     
- Partials     2615     2616       +1     
Flag Coverage Δ
tests 86.15% <92.23%> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@tnull tnull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, seems maybe a bit excessive, but fine by me. No need to check this on every CI run though, let's just move it to a weekly cronjob?

Comment thread .github/workflows/build.yml Outdated
Copy link
Copy Markdown
Contributor

@tnull tnull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, please squash.

Comment thread .github/workflows/check_unicode.yml
Comment thread .github/workflows/check_unicode.yml
Comment thread .github/workflows/check_unicode.yml Outdated
@tnull
Copy link
Copy Markdown
Contributor

tnull commented May 8, 2026

Claude's reviews seem legit though

1a01b5a added detection of unicode
format characters in `PrintableString`, but used a hard-coded table
which may eventually become out of date.

Here we switch to an auto-generated table, include all
`General_Category` `Other` characters, and also ban unallocated
code points.

Finally, CI validates that the file is kept up to date.

Written by Claude
@TheBlueMatt TheBlueMatt force-pushed the 2026-05-unicode-autogen branch from 2de5954 to 65e8cc8 Compare May 8, 2026 19:44
@TheBlueMatt
Copy link
Copy Markdown
Collaborator Author

Squashed and fixed claude's comments:

$ git diff-tree -U2 2de5954d9 65e8cc8d5
diff --git a/.github/workflows/check_unicode.yml b/.github/workflows/check_unicode.yml
index c22a4e3b29..a01add3f81 100644
--- a/.github/workflows/check_unicode.yml
+++ b/.github/workflows/check_unicode.yml
@@ -5,4 +5,5 @@ on:
     - cron: '42 3 * * *'

+jobs:
   check-unicode:
     runs-on: ubuntu-latest
@@ -10,4 +11,6 @@ on:
       issues: write
     steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
       - name: Check unicode file state
         env:
@@ -21,3 +24,3 @@ on:
             BODY="The unicode character listing is out of date, see $RUN_URL"
             gh issue create --title "$TITLE" --body "$BODY"
-        fi
+          fi

TITLE="Unicode listing out of date: ${{ github.workflow }}"
RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
BODY="The unicode character listing is out of date, see $RUN_URL"
gh issue create --title "$TITLE" --body "$BODY"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: No deduplication — this creates a new issue every day the file is out of date. Unicode updates are infrequent (roughly annual), but if nobody regenerates the file promptly, this will spam the issue tracker with identical issues.

build.yml already has the right pattern (lines 380-391): check for an existing open issue with a label, and comment on it instead of creating a duplicate. This workflow should do the same.

Minimal fix sketch:

          LABEL="unicode outdated"
          gh label create "$LABEL" 2>/dev/null || true
          EXISTING=$(gh issue list --label "$LABEL" --state open --json number --jq '.[0].number // empty')
          if [ -n "$EXISTING" ]; then
            gh issue comment "$EXISTING" --body "$BODY"
          else
            gh issue create --title "$TITLE" --label "$LABEL" --body "$BODY"
          fi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants